Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some updates to the API for archived repos #27149

Merged
merged 5 commits into from
Sep 21, 2023
Merged

Conversation

JakobDev
Copy link
Contributor

While playing around with the API for archived repos I found some nits that this PR fixes.

  1. If a repo is archived, the API no longer returns a generic 404. Instead it returns a 423 (locked) with a meaningful error.
  2. Some endpoints were missing the check if a repo is archived. I fixed that.
  3. I also think it is a good idea to check in the underlying functions, if a repo is archived. If you now call e.g. ApplyDiffPatch for an archived repo, it now returns a ErrRepoIsArchived error. Those functions should never be called if a repo is archived, so you should never get this error in theory, but it's better to make sure it doesn't happen.

This PR makes no claim to completeness. I may have missed some function.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Sep 20, 2023
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 20, 2023
@github-actions github-actions bot added the modifies/api This PR adds API routes or modifies them label Sep 20, 2023
models/repo/repo.go Outdated Show resolved Hide resolved
models/repo/repo.go Outdated Show resolved Hide resolved
models/repo/repo.go Outdated Show resolved Hide resolved
modules/context/api.go Outdated Show resolved Hide resolved
modules/context/api.go Outdated Show resolved Hide resolved
@@ -117,17 +117,13 @@ func DeleteBranch(ctx *context.APIContext) {
// "$ref": "#/responses/error"
// "404":
// "$ref": "#/responses/notFound"

// "423":
// "$ref": "#/responses/repoArchived"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also add a description, here and everywhere else:

Suggested change
// "$ref": "#/responses/repoArchived"
// "$ref": "#/responses/repoArchived"
// "description": "The repo is archived"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description is added by swagger automatically

routers/api/v1/api.go Outdated Show resolved Hide resolved
@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Sep 20, 2023
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Sep 21, 2023
@jolheiser jolheiser enabled auto-merge (squash) September 21, 2023 22:54
@jolheiser jolheiser added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Sep 21, 2023
@jolheiser jolheiser merged commit 28f9b31 into go-gitea:main Sep 21, 2023
25 checks passed
@GiteaBot GiteaBot added this to the 1.22.0 milestone Sep 21, 2023
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Sep 21, 2023
@JakobDev JakobDev deleted the archiveapi branch September 22, 2023 05:55
zjjhot added a commit to zjjhot/gitea that referenced this pull request Sep 22, 2023
* giteaofficial/main:
  [skip ci] Updated translations via Crowdin
  Updates to the API for archived repos (go-gitea#27149)
  Fix release URL in webhooks (go-gitea#27182)
  Fix dropdown icon position (go-gitea#27175)
  Fix repo sub menu (go-gitea#27169)
  Fix review request number and add more tests (go-gitea#27104)
  Fix the variable regexp pattern on web page (go-gitea#27161)
  Fix organization field being null in POST /orgs/{orgid}/teams (go-gitea#27150)
  Add index to `issue_user.issue_id` (go-gitea#27154)
  [skip ci] Updated translations via Crowdin
  Start development on Gitea 1.22 (go-gitea#27155)
  Fix successful return value for `SyncAndGetUserSpecificDiff` (go-gitea#27152)
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Dec 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/api This PR adds API routes or modifies them size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants